package runnerworm.core;

/**
 * <p>Title: HelpAvailableEvent</p>
 * <p>Description: The event that will hold the text to be shown on the help screen.</p>
 * @author Guilherme Mauro Germoglio Barbosa
 */

public class HelpAvailableEvent
    extends AvailableEvent {

  /**
   * The help text.
   */
  private String helpText;

  /**
   * Will need the source and the help text.
   * @param source The event's source.
   * @param helpText The text to be shown.
   */
  public HelpAvailableEvent(AvailableEventLauncher source, String helpText) {
    super(source, HELP_AVAILABLE);
    this.helpText = helpText;
  }

  /**
   * Returns the text.
   * @return The text that is to be shown on the help screen.
   */
  public String getHelpText() {
    return helpText;
  }
}